home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 015a / obskit.zip / QUIKSTRT.DOC < prev    next >
Text File  |  1992-01-11  |  21KB  |  528 lines
  1.                          Obs Toolkit Version 1.5
  2.  
  3.                              Contrails, Inc.
  4.                               P.O. Box 2759
  5.                             Lompoc, CA 93438
  6.  
  7.                              (805) 733-2808
  8.  
  9.  
  10.                               Introduction
  11.                               ------------
  12.  
  13. Welcome to Obs Toolkit. We thank you for your interest. The OBSKIT.DOC is
  14. a large file with a all of the detailed information. We recommend that
  15. you read it. This file is provided to get you up and running with a
  16. minimum of hassel.
  17.  
  18. The information in this file, should introduce you to the Toolkit, and
  19. get you interested in no time.
  20.  
  21. Obs Toolkit requires DOS 3.0 or higher and 256Kb of memory. Obs Toolkit
  22. is complementary to all versions of DOS including DOS 5.
  23.  
  24.  
  25.                                 Overview
  26.                                 --------
  27.  
  28. This guide is structured to describe the tools; give you a taste of the
  29. Toolkits capabilities and describe some terms and interfaces.
  30.  
  31.  
  32.                              Supplied Files
  33.                              --------------
  34.  
  35. The files that make up Obs Tools are:
  36.    o ALIAS.EXE    - Alias, the alias generator
  37.    o DIRSTACK.COM - A directory stack without Alias translator
  38.    o DS.EXE       - DirSize, a tree with sizes
  39.    o EE.EXE       - EnvEdit, a DOS environment editor
  40.    o FD.EXE       - FileDump, the file viewer
  41.    o LF.EXE       - ListFiles, the file lister
  42.    o LOCATE.EXE   - Locate, the executable command and file locator
  43.    o MF.EXE       - MultiFile, the file manipulator
  44.    o OBSRES.COM   - Alias translator, dictionary, and directory stack
  45.    o OCD.EXE      - ObsCD, a super-intelligent Change Directory
  46.    o RERES.COM    - Recapture the command line
  47.  
  48. The files with alias definitions are:
  49.    o ALIASES.DOS  - Replaces DOS internal commands
  50.    o ALIASES.REC  - A comprehensive set of recursive aliases
  51.  
  52.    o xDOS.CFG     - Aliases for NDOS and 4DOS users
  53.    o PCED.CFG     - Aliases for PCED users
  54.    o CMD_ED.CFG   - Aliases for CMDEDIT users
  55.  
  56. Support files are:
  57.    o INSTALL.BAT  - Automatic installation into your AUTOEXEC.BAT
  58.    o TRYIT.BAT    - Quick Start batch file, to get you up and running
  59.  
  60.    o OBSKIT.DOC   - Obs Toolkit users manual
  61.    o QUIKSTRT.DOC - This file (introduction, orientation, quick start)
  62.    o README.DOC   - Startup advice
  63.    o REGISTER.DOC - Registration form
  64.    o UPDATES.DOC  - Changes since version 1.0
  65.    o UPGRADE.DOC  - Notes for users of version 1.0
  66.  
  67.  
  68.                           Toolkit Capabilities
  69.                           --------------------
  70.  
  71. The Toolkits sole purpose is to give you, the user, POWER! No, it won't
  72. generate electricity, but it will allow you to do things at the command
  73. line, or in batch files, that were never before possible.
  74.  
  75. Obs Toolkit can be used to generate your own commands! Obs Toolkit can
  76. provide custom commands, like (this is by no means an exhaustive set):
  77.  
  78.    o ALIAS  (define your own commands)
  79.    o ATTRIB (set and/or clear any DOS attributes)
  80.    o CD     (fuzzy matching, across disks, push, pop, up)
  81.    o COPY   (add, update, replace, add & update, archive only)
  82.    o DELETE (files, directories with contents)
  83.    o DIR    (any sort, duplicates, old files, identical contents)
  84.    o LOCATE (commands, files, multiple disks)
  85.    o MOVE   (between directories, across disks, whole directories)
  86.    o RENAME (files, directories)
  87.    o SET    (any environment, editor, long variables, batchable)
  88.    o TOUCH  (set file date and time to any valid timestamp)
  89.    o TREE   (with directory sizes, creation dates)
  90.    o TYPE   (ASCII only, HEX dump, strings, counts, multiple files)
  91.  
  92. Obs Toolkit can be used within batch files. Each tool returns an
  93. errorlevel, and a few tools have options specifically tailored for batch
  94. use.
  95.  
  96. The errorlevels generated are:
  97.  
  98.   0 - NO ERROR         - No error encountered
  99.   1 - NOT FOUND        - File or object was "NOT FOUND"
  100.   2 - ABORTED          - The user chose to "ABORT" the operation
  101.   3 - OPERATION FAILED - The requested "OPERATION FAILED"
  102.   4 - LIMIT EXCEEDED   - The operation exceeded the tools "LIMIT"
  103.   5 - USAGE ERROR      - The tool displayed a "USAGE" error
  104.   6 - INSTALL FAILED   - The tool was unable to "INSTALL"
  105.  
  106.  
  107.                            Quick Installation
  108.                            ------------------
  109. A quick installation patch is provided so that trying out the Toolkit is
  110. completely painless. This is a description of that installation process:
  111.  
  112. The way to get started running Obs Toolkit right now, is to move to the
  113. directory where the Toolkit is located and type:
  114.  
  115.   C> TRYIT
  116.  
  117.   NOTE: NDOS and 4DOS users
  118.     OBSRES will not be able to swap the command line. You should use the
  119.     XDOS.CFG file. Instead of installing OBSRES install only a DirStack
  120.     using DIRSTACK 9 to minimize the memory consumption.
  121.  
  122. TRYIT.BAT will only map the existing DOS commands to Toolkit equivalents.
  123. The Toolkit has much more power than what is shown below. The TRYIT.BAT
  124. is just providing a taste.
  125.                     ~~~~~
  126. Replaced Commands
  127. -----------------
  128. Obs Toolkit will be installed into memory (takes up 3K RAM) and will
  129. supplant the following DOS commands:
  130.   o CD, CHDIR   - mapped to ObsCD     (OCD)
  131.   o COPY        - mapped to MultiFile (MF)
  132.   o DEL, ERASE  - mapped to MultiFile (MF)
  133.   o DIR         - mapped to ListFiles (LF)
  134.   o MD, MKDIR   - mapped to ObsCD     (OCD)
  135.   o PATH        - mapped to EnvEdit   (EE)
  136.   o PROMPT      - mapped to EnvEdit   (EE)
  137.   o RD, RMDIR   - mapped to ObsCD     (OCD)
  138.   o REN, RENAME - mapped to MultiFile (MF)
  139.   o SET         - mapped to EnvEdit   (EE)
  140.   o TYPE        - mapped to FileDump  (FD)
  141.  
  142.  
  143. Building a HotDir file
  144. ----------------------
  145. To enable HotDir support for changing directories type:
  146.  
  147.   C> OCD /READ
  148.  
  149. This will scan all disks and remember the locations of all directories.
  150.  
  151. If you have RAM disks, network drives, or any directories that you don't
  152. want to include in the HotDir file, then refer to the Users Manual for
  153. the commands to tailor the HotDir file to your liking. ObsCD is real
  154. agreeable.
  155.  
  156.  
  157. Turning the Toolkit ON and OFF
  158. ------------------------------
  159. When you run TRYIT.BAT the Toolkit is ON. You can switch the Toolkit ON
  160. and OFF by using the DOT COMMANDS (.command) at the DOS prompt.
  161.  
  162. The .COMMANDS available are:
  163.   .ON     - Turn the Toolkit ON
  164.   .OFf    - Turn the Toolkit OFF
  165.   .Echo   - Display ALIAS translations
  166.   .Noecho - Do not display ALIAS translations
  167.  
  168. You can also skip an alias translation by prefixing the command with a
  169. space (ALIAS can change the Skip Character):
  170.  
  171.   C>DIR  (uses the alias)
  172.   C> DIR (uses DOS)
  173.  
  174.  
  175.                          Persistent Installation
  176.                          -----------------------
  177. This installation will modify your AUTOEXEC.BAT file so that the Toolkit
  178. interface will be available each time you boot your computer.
  179.  
  180. The commands provided are documented in the ALIASES.REC file.
  181.  
  182. A new file will be created in the Toolkit directory (ALIASES.FIL) which
  183. contains the aliases from ALIASES.REC and has the OB alias defined.
  184.  
  185. The AUTOEXEC.BAT file will be modified (appended to) to contain:
  186.   [obs_path]\OBSRES
  187.   [obs_path]\ALIAS /FILE [obs_path]\ALIASES.FIL
  188.  
  189. To perform the persistent installation you must:
  190.   1) Change to the directory where the Toolkit is located
  191.   2) Type "INSTALL" at the command line
  192.  
  193. INSTALL.BAT is providing you with a full seven course meal!
  194.                                          ~~~~~ ~~~~~~ ~~~~
  195. If you haven't already done a HotDir scan (OCD /READ) and you want OCD
  196. HotDir support then refer to the section "Building a HotDir File" above.
  197.  
  198. You may want to edit your AUTOEXEC.BAT file to add the Toolkit directory
  199. to your path (this is required for batch file support unless you use
  200. fully qualified filenames).
  201.  
  202. If your AUTOEXEC.BAT launches a menu program (or Windows) you must
  203. manually move the two Toolkit commands before the menu program commands
  204. or the Toolkit interface will not be available until after you exit the
  205. menu program.
  206.  
  207.  
  208.                             Using Obs Toolkit
  209.                             -----------------
  210.  
  211. Getting Help
  212. ------------
  213. All of Obs Tools have embedded help screens. To access the help screen
  214. just type /? after the program name. (e.g., OCD /?)
  215.  
  216.  
  217. WildSpecs
  218. ---------
  219. WildSpecs are a superset of the DOS wildcards. They are used the same,
  220. except that '*'s can be used anywhere within a file specification, and
  221. '?'s stand for a single character that is required.
  222.  
  223.   ? - matches any single character    (a character is required)
  224.   * - matches any group of characters (zero or more characters may match)
  225.  
  226. Now you can do things like
  227.  
  228.   C>DIR *test*.* (directory of all files with TEST embedded somwhere in
  229.                   the file name).
  230.  
  231.  
  232. SmartPaths
  233. ----------
  234. SmartPaths are directories on the DirStack that you can access as if they
  235. were DOS drives. Create SmartPaths using OCD /PUSH. Access SmartPaths by
  236. using 1: - 9:.
  237.  
  238.   OCD /LIST    (Reports contents of DirStack)
  239.  
  240. SmartPaths work just like regular drives. You can also OCD /POP back.
  241.  
  242. You use SmartPaths by typing the SmartPath number instead of the drive
  243. letter.
  244.  
  245.   C>DIR 1:*.exe or
  246.   C>COPY test.bat 2:
  247.  
  248.  
  249. Date and Time
  250. -------------
  251.   "Date Time" (Quotes required to supply both Date & Time)
  252.      date = mm-dd-yy - The full date must be specified
  253.      date = -days    - That many days in the past
  254.  
  255.      time = hh:mm:ss - The minutes & seconds are optional
  256.      time = .        - This translates to the current time
  257.  
  258.  
  259. Line Editor
  260. -----------
  261.   Up Arrow       Move one line up (multiple line display only)
  262.   Down Arrow     Move one line down (multiple line display only)
  263.   Left Arrow     Move one character to the left
  264.   Right Arrow    Move one character to the right
  265.   CTRL-Left      Move one word to the left
  266.   CTRL-Right     Move one word to the right
  267.   INSERT         Toggle Insert/Overstrike mode
  268.   HOME     (^A)  Move to the beginning of the edit field
  269.   END      (^E)  Move to the end of the edit field
  270.   DELETE   (^D)  Delete the current character
  271.   BACKSPACE      Delete the previous character
  272.   CTRL-Y         Delete the entire line
  273.   RETURN (ALT-X) Store changes and exit
  274.   ESCAPE         Abort changes and exit
  275.  
  276. The line editor is built into the Environment Editor and Alias. You bring
  277. up the editor by using the /EDIT qualifier.
  278.  
  279. To edit your PATH you can type:
  280.  
  281.   C>EE /EDIT PATH
  282.  
  283.  
  284. Scrolling
  285. ---------
  286. Obs tools all support display paging, so that the text does not scroll
  287. off the screen before you have a chance to read it.
  288.  
  289. Paging can be activated by using the tools /PAGE switch.
  290.  
  291. You can enter and exit paging mode interactively, by pressing <escape>.
  292.  
  293.  
  294.                            Printing OBSKIT.DOC
  295.                            -------------------
  296. The following procedure should be used to print OBSKIT.DOC:
  297.  
  298.   1) Turn on your printer
  299.   2) Type COPY OBSKIT.DOC PRN
  300.   3) Get a cup of Java (it will take a short while)
  301.  
  302.  
  303.                              Quick Reference
  304.                              ---------------
  305.  
  306. ------------------------------------------------------------------------
  307.                                   Alias
  308. ------------------------------------------------------------------------
  309. Usage:
  310.   alias [/[NO]Page] [name]    - Report synonym(s) (wildspecs supported)
  311.   alias [/NOSpace]   name cmd - Define synonym    (abbreviate using "'")
  312.   alias /NUll        name     - Define null synonym
  313.   alias /Make        name     - Define a path alias
  314.   alias /EDit        name     - Edit alias definition
  315.   alias /CLear                - Remove ALL synonyms
  316.   alias /Delete      name     - Remove synonym
  317.   alias /File        file.ext - Read alias commands from file.ext
  318.  
  319.   alias [options] - (configures/info on the translator; may be combined)
  320.      /[NO]CAse    - Case sensitive aliases
  321.      /[NO]ECho    - Echo translations
  322.      /[NO]Recurse - Recursively apply aliases
  323.      /OFf         - Turn translator Off
  324.      /ON          - Turn translator On
  325.      /STatus      - Report active conditions
  326.      /SKipchar x  - Define character to skip translation
  327.  
  328.  
  329. ------------------------------------------------------------------------
  330.                                  DirSize
  331. ------------------------------------------------------------------------
  332. Usage: DS [options] [path]
  333. Options are:
  334.    /BYDAte     - Sort tree in date order
  335.    /BYDOs      * No tree sort
  336.    /BYName     - Sort tree in alphabetical order
  337.    /BYSize     - Sort tree from smallest to largest
  338.    /DEpth num  - Draw tree to depth 'num'
  339.    /[NO]Count  - Continue to count files
  340.    /[NO]DAte   - Display creation date
  341.    /[NO]Page   - Page output
  342.    /[NO]Size   + Display sizes
  343.  
  344.  
  345. ------------------------------------------------------------------------
  346.                                  EnvEdit
  347. ------------------------------------------------------------------------
  348. Usage: EE [options] [variable[=[definition]]]
  349. Options are:
  350.    /CUrrent    - Use the Current environment
  351.    /DOs        * Use the active DOS environment
  352.    /MASter     - Use the Master environment (aka /ROot)
  353.    /Parent     - Use the Parent environment
  354.  
  355.    /[NO]CAse   - Name is case sensitive
  356.    /[NO]Edit   - Permits usage of the line editor
  357.    /[NO]STatus - Report status on the environment
  358.    /[NO]REMove + Remove variable on "VAR="
  359.    /[NO]Quiet  - No display output
  360.  
  361.    /Append     - Append "text" to end of definition
  362.    /INSert     - Insert "text" to beginning of definition
  363.    /REPlace    - Replace "text_1" with "text_2" in definition
  364.  
  365.    /COpy       - Duplicate environment variable
  366.    /DELete     - Delete environment variable
  367.    /MAKe       - Define a variable to be the current directory
  368.    /REName     - Rename environment variable
  369.  
  370.    /INCrement  - Add one to the variable
  371.    /DECrement  - Subtract one from the variable
  372.    /Upper      - Change definition to all upper case
  373.    /LOWer      - Change definition to all lower case
  374.  
  375.    /CLear      - Clear the environment
  376.    /LOAd       - Load DOS environment from file
  377.    /SAve       - Store environment into file
  378.  
  379.  
  380. ------------------------------------------------------------------------
  381.                                 FileDump
  382. ------------------------------------------------------------------------
  383. Usage: FD [options] {[SmartPath][directory]WildSpec}
  384. Options are:
  385.   /Ascii        - Ascii output
  386.   /COUnt        - Count chars, words, lines, and pages
  387.   /Hex          - Hex output
  388.   /TExt         * Text output
  389.   /STrings #    - String output (# is minimum string length)
  390.  
  391.   /BInary       - Force input to be binary
  392.   /BEgin   #[x] - Start offset
  393.   /End     #[x] - End offset
  394.   /TAb     #    - Set tab setting (normally 8)
  395.   /7            - Strip high bit
  396.   /8            * Do not strip high bit
  397.  
  398.   /[NO]COMpress - Compress runs
  399.   /[NO]NUmber   - Number lines (/TEXT only)
  400.   /[NO]Page     - Page output
  401.   /[NO]SMart    - Smart type logic
  402.   /[NO]Wrap     + Wrap long lines
  403.  
  404.  
  405. ------------------------------------------------------------------------
  406.                                 ListFiles
  407. ------------------------------------------------------------------------
  408. Usage: LF [options] [SmartPath][directory]{WildSpec}
  409. Options are: (/-x for B C G L O P R W X)
  410.    1  - 12 hour clock;  2 - 24 hour clock
  411.    Ax - Attribute
  412.       A - Archive, H - Hidden,  R - Read-only, S - System, D - Directory
  413.       + - include, - - exclude, * - required
  414.    Bx - Brief output (B+ for full pathnames)
  415.    Cx - Command listing (B - Beginning, E - End, T - Text)
  416.    Dx - Detect special conditions
  417.       C - duplicate Contents  D - Duplicate entry,
  418.       H - Hidden programs     O - Old files
  419.    G  - report Grand total information only
  420.    L  - Lower case
  421.    Ox - Order by (-x to reverse)
  422.       U - Unsorted,  E - by Extension, N - by Name, G - Group directories
  423.       S - by Size,   D - by Date/time, R - Reverse output
  424.    P  - Page output
  425.    R  - Recurse Sub-directories
  426.    Sx - Size restriction (L - Less-than, E - Equal,  G - Greater than)
  427.    Tx - Time restriction (B - Before,    E - Exact,  S - Since)
  428.    Wx - Wide output (x is number of columns (1-5))
  429.    Xx - Exclude WildSpec (may be repeated)
  430.  
  431.  
  432. ------------------------------------------------------------------------
  433.                                  Locate
  434. ------------------------------------------------------------------------
  435. Usage: LOCATE [options] {disk} [name]
  436. Options are:
  437.    /COmmand    * Search for a command
  438.    /FIle       - Search for a file
  439.  
  440.    /[NO]All    - Include system and hidden files (/File only)
  441.    /[NO]CHange - Change to directory where /COMMAND was found
  442.    /[NO]FUll   - Display all file information for commands
  443.    /[NO]Page   - Page output
  444.    /[NO]Wide   - Wide output
  445.  
  446.  
  447. ------------------------------------------------------------------------
  448.                                 MultiFile
  449. ------------------------------------------------------------------------
  450. Usage: MF [options] [SmartPath]WildSpec [SmartPath][filespec]
  451. Options are: (-x cancels ! H I F P N Q R V X Y)
  452.    C   - Copy all files                 CU  - Update existing files
  453.    CR  - Replace existing files         CA  - Add new files
  454.    CAR - Add & Replace (like DOS)       CUA - Update & Add
  455.    D   - Delete                         M   - Move/Rename
  456.    SAx - Set Attributes                 STx - Set file date & Time
  457.  
  458.    Ax  - Attribute selection
  459.        A - archive,  H - hidden,  R - read-only,  S - system
  460.        + - include,  - - exclude, * - required
  461.    I   - Ignore overwrites by skipping file
  462.    N   - Select archive files, reset after copy (copy only)
  463.    Tx  - Time restrictions (B - Before,  E - Exact,  S - Since)
  464.    Xx  - Exclude WildSpec (may be repeated)
  465.  
  466.    !   - Test run, perform no actions   H   - Hoist to target / flatten tree
  467.    F   - Force all operations           P   - Prompt at each file
  468.    Q   - Quiet operations               R   - Recurse Sub-directories
  469.    V   - Verify writes                  Y   - Yes to cautions
  470.  
  471.  
  472. ------------------------------------------------------------------------
  473.                                   ObsCD
  474. ------------------------------------------------------------------------
  475. Usage: OCD [options] [SmartPath][dirname]
  476. Options are:
  477.    /LIst        - List the DirStack and default dirs
  478.    /MKdir       - Make directory (MD)
  479.    /POp [n]     - Restores a pushed location   (default=1)
  480.    /REad        - Read a new HotDir file
  481.    /RMdir       - Remove directory (RD)
  482.    /STack       - Put the specified directory on the DirStack
  483.    /UP  [n]     - Moves up 'n' directories     (default=1)
  484.  
  485.    /DRives      - Drives to /READ or /LIST
  486.    /LAst        - Last drive to scan during /READ or /LIST
  487.    /eXclude     - Exclude directory from /READ
  488.  
  489.    /Basedisk    - Lowest hard drive letter     (default 'C:')
  490.    /[NO]Change  - Change into directory during /MKDIR
  491.    /[NO]DIsk    - Allows disk changes
  492.    /[NO]ECho    - Reports directory changed to
  493.    /[NO]Force   - Force push (no duplicate check)
  494.    /[NO]PUsh    - Saves current location to the DirStack
  495.    /[NO]SCan    - Force scan for directory change
  496.    /[NO]UPDate  + OK to update the HotDir file
  497.  
  498.  
  499.                                 Shareware
  500.                                 ---------
  501.  
  502. Obs Toolkit is distributed as Shareware. This is a Shareware copy that
  503. you are entitled to use and evaluate. If you would like to continue using
  504. this Toolkit after a reasonable evaluation period, then you must register
  505. the Toolkit with Contrails, Inc.
  506.  
  507. A license is required to use Obs Toolkit in corporations or institutions.
  508.  
  509. Registration information is contained in the Users Manual OBSKIT.DOC, and
  510. in the registration form REGISTER.DOC.
  511.  
  512. Registration is only $39.00.
  513.  
  514.  
  515.                               ASP Ombudsman
  516.                               -------------
  517.  
  518. This program is produced by a member of the Association of Shareware
  519. Professionals (ASP). ASP wants to make sure that the shareware principle
  520. works for you. If you are unable to resolve a shareware-related problem
  521. with an ASP member by contacting the member directly, ASP may be able to
  522. help. The ASP Ombudsman can help you resolve a dispute or problem with an
  523. ASP member, but does not provide technical support for members' products.
  524. Please write to the ASP Ombudsman at 545 Grover Road, Muskegon, MI 49442-
  525. 9427 or send a Compuserve message via CompuServe Mail to ASP Ombudsman
  526. 70007,3536"
  527.  
  528.